home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / bin / h2xs < prev    next >
Text File  |  2009-10-01  |  60KB  |  2,188 lines
  1. #!/usr/bin/perl
  2.     eval 'exec /usr/bin/perl -S $0 ${1+"$@"}'
  3.     if $running_under_some_shell;
  4.  
  5. use warnings;
  6.  
  7. =head1 NAME
  8.  
  9. h2xs - convert .h C header files to Perl extensions
  10.  
  11. =head1 SYNOPSIS
  12.  
  13. B<h2xs> [B<OPTIONS> ...] [headerfile ... [extra_libraries]]
  14.  
  15. B<h2xs> B<-h>|B<-?>|B<--help>
  16.  
  17. =head1 DESCRIPTION
  18.  
  19. I<h2xs> builds a Perl extension from C header files.  The extension
  20. will include functions which can be used to retrieve the value of any
  21. #define statement which was in the C header files.
  22.  
  23. The I<module_name> will be used for the name of the extension.  If
  24. module_name is not supplied then the name of the first header file
  25. will be used, with the first character capitalized.
  26.  
  27. If the extension might need extra libraries, they should be included
  28. here.  The extension Makefile.PL will take care of checking whether
  29. the libraries actually exist and how they should be loaded.  The extra
  30. libraries should be specified in the form -lm -lposix, etc, just as on
  31. the cc command line.  By default, the Makefile.PL will search through
  32. the library path determined by Configure.  That path can be augmented
  33. by including arguments of the form B<-L/another/library/path> in the
  34. extra-libraries argument.
  35.  
  36. In spite of its name, I<h2xs> may also be used to create a skeleton pure
  37. Perl module. See the B<-X> option.
  38.  
  39. =head1 OPTIONS
  40.  
  41. =over 5
  42.  
  43. =item B<-A>, B<--omit-autoload>
  44.  
  45. Omit all autoload facilities.  This is the same as B<-c> but also
  46. removes the S<C<use AutoLoader>> statement from the .pm file.
  47.  
  48. =item B<-B>, B<--beta-version>
  49.  
  50. Use an alpha/beta style version number.  Causes version number to
  51. be "0.00_01" unless B<-v> is specified.
  52.  
  53. =item B<-C>, B<--omit-changes>
  54.  
  55. Omits creation of the F<Changes> file, and adds a HISTORY section to
  56. the POD template.
  57.  
  58. =item B<-F>, B<--cpp-flags>=I<addflags>
  59.  
  60. Additional flags to specify to C preprocessor when scanning header for
  61. function declarations.  Writes these options in the generated F<Makefile.PL>
  62. too.
  63.  
  64. =item B<-M>, B<--func-mask>=I<regular expression>
  65.  
  66. selects functions/macros to process.
  67.  
  68. =item B<-O>, B<--overwrite-ok>
  69.  
  70. Allows a pre-existing extension directory to be overwritten.
  71.  
  72. =item B<-P>, B<--omit-pod>
  73.  
  74. Omit the autogenerated stub POD section.
  75.  
  76. =item B<-X>, B<--omit-XS>
  77.  
  78. Omit the XS portion. Used to generate a skeleton pure Perl module.
  79. C<-c> and C<-f> are implicitly enabled.
  80.  
  81. =item B<-a>, B<--gen-accessors>
  82.  
  83. Generate an accessor method for each element of structs and unions. The
  84. generated methods are named after the element name; will return the current
  85. value of the element if called without additional arguments; and will set
  86. the element to the supplied value (and return the new value) if called with
  87. an additional argument. Embedded structures and unions are returned as a
  88. pointer rather than the complete structure, to facilitate chained calls.
  89.  
  90. These methods all apply to the Ptr type for the structure; additionally
  91. two methods are constructed for the structure type itself, C<_to_ptr>
  92. which returns a Ptr type pointing to the same structure, and a C<new>
  93. method to construct and return a new structure, initialised to zeroes.
  94.  
  95. =item B<-b>, B<--compat-version>=I<version>
  96.  
  97. Generates a .pm file which is backwards compatible with the specified
  98. perl version.
  99.  
  100. For versions < 5.6.0, the changes are.
  101.     - no use of 'our' (uses 'use vars' instead)
  102.     - no 'use warnings'
  103.  
  104. Specifying a compatibility version higher than the version of perl you
  105. are using to run h2xs will have no effect.  If unspecified h2xs will default
  106. to compatibility with the version of perl you are using to run h2xs.
  107.  
  108. =item B<-c>, B<--omit-constant>
  109.  
  110. Omit C<constant()> from the .xs file and corresponding specialised
  111. C<AUTOLOAD> from the .pm file.
  112.  
  113. =item B<-d>, B<--debugging>
  114.  
  115. Turn on debugging messages.
  116.  
  117. =item B<-e>, B<--omit-enums>=[I<regular expression>]
  118.  
  119. If I<regular expression> is not given, skip all constants that are defined in
  120. a C enumeration. Otherwise skip only those constants that are defined in an
  121. enum whose name matches I<regular expression>.
  122.  
  123. Since I<regular expression> is optional, make sure that this switch is followed
  124. by at least one other switch if you omit I<regular expression> and have some
  125. pending arguments such as header-file names. This is ok:
  126.  
  127.     h2xs -e -n Module::Foo foo.h
  128.  
  129. This is not ok:
  130.  
  131.     h2xs -n Module::Foo -e foo.h
  132.  
  133. In the latter, foo.h is taken as I<regular expression>.
  134.  
  135. =item B<-f>, B<--force>
  136.  
  137. Allows an extension to be created for a header even if that header is
  138. not found in standard include directories.
  139.  
  140. =item B<-g>, B<--global>
  141.  
  142. Include code for safely storing static data in the .xs file.
  143. Extensions that do no make use of static data can ignore this option.
  144.  
  145. =item B<-h>, B<-?>, B<--help>
  146.  
  147. Print the usage, help and version for this h2xs and exit.
  148.  
  149. =item B<-k>, B<--omit-const-func>
  150.  
  151. For function arguments declared as C<const>, omit the const attribute in the
  152. generated XS code.
  153.  
  154. =item B<-m>, B<--gen-tied-var>
  155.  
  156. B<Experimental>: for each variable declared in the header file(s), declare
  157. a perl variable of the same name magically tied to the C variable.
  158.  
  159. =item B<-n>, B<--name>=I<module_name>
  160.  
  161. Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
  162.  
  163. =item B<-o>, B<--opaque-re>=I<regular expression>
  164.  
  165. Use "opaque" data type for the C types matched by the regular
  166. expression, even if these types are C<typedef>-equivalent to types
  167. from typemaps.  Should not be used without B<-x>.
  168.  
  169. This may be useful since, say, types which are C<typedef>-equivalent
  170. to integers may represent OS-related handles, and one may want to work
  171. with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
  172. Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
  173. types.
  174.  
  175. The type-to-match is whitewashed (except for commas, which have no
  176. whitespace before them, and multiple C<*> which have no whitespace
  177. between them).
  178.  
  179. =item B<-p>, B<--remove-prefix>=I<prefix>
  180.  
  181. Specify a prefix which should be removed from the Perl function names,
  182. e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
  183. the prefix from functions that are autoloaded via the C<constant()>
  184. mechanism.
  185.  
  186. =item B<-s>, B<--const-subs>=I<sub1,sub2>
  187.  
  188. Create a perl subroutine for the specified macros rather than autoload
  189. with the constant() subroutine.  These macros are assumed to have a
  190. return type of B<char *>, e.g.,
  191. S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
  192.  
  193. =item B<-t>, B<--default-type>=I<type>
  194.  
  195. Specify the internal type that the constant() mechanism uses for macros.
  196. The default is IV (signed integer).  Currently all macros found during the
  197. header scanning process will be assumed to have this type.  Future versions
  198. of C<h2xs> may gain the ability to make educated guesses.
  199.  
  200. =item B<--use-new-tests>
  201.  
  202. When B<--compat-version> (B<-b>) is present the generated tests will use
  203. C<Test::More> rather than C<Test> which is the default for versions before
  204. 5.7.2 .   C<Test::More> will be added to PREREQ_PM in the generated
  205. C<Makefile.PL>.
  206.  
  207. =item B<--use-old-tests>
  208.  
  209. Will force the generation of test code that uses the older C<Test> module.
  210.  
  211. =item B<--skip-exporter>
  212.  
  213. Do not use C<Exporter> and/or export any symbol.
  214.  
  215. =item B<--skip-ppport>
  216.  
  217. Do not use C<Devel::PPPort>: no portability to older version.
  218.  
  219. =item B<--skip-autoloader>
  220.  
  221. Do not use the module C<AutoLoader>; but keep the constant() function
  222. and C<sub AUTOLOAD> for constants.
  223.  
  224. =item B<--skip-strict>
  225.  
  226. Do not use the pragma C<strict>.
  227.  
  228. =item B<--skip-warnings>
  229.  
  230. Do not use the pragma C<warnings>.
  231.  
  232. =item B<-v>, B<--version>=I<version>
  233.  
  234. Specify a version number for this extension.  This version number is added
  235. to the templates.  The default is 0.01, or 0.00_01 if C<-B> is specified.
  236. The version specified should be numeric.
  237.  
  238. =item B<-x>, B<--autogen-xsubs>
  239.  
  240. Automatically generate XSUBs basing on function declarations in the
  241. header file.  The package C<C::Scan> should be installed. If this
  242. option is specified, the name of the header file may look like
  243. C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
  244. string, but XSUBs are emitted only for the declarations included from
  245. file NAME2.
  246.  
  247. Note that some types of arguments/return-values for functions may
  248. result in XSUB-declarations/typemap-entries which need
  249. hand-editing. Such may be objects which cannot be converted from/to a
  250. pointer (like C<long long>), pointers to functions, or arrays.  See
  251. also the section on L<LIMITATIONS of B<-x>>.
  252.  
  253. =back
  254.  
  255. =head1 EXAMPLES
  256.  
  257.  
  258.     # Default behavior, extension is Rusers
  259.     h2xs rpcsvc/rusers
  260.  
  261.     # Same, but extension is RUSERS
  262.     h2xs -n RUSERS rpcsvc/rusers
  263.  
  264.     # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
  265.     h2xs rpcsvc::rusers
  266.  
  267.     # Extension is ONC::RPC.  Still finds <rpcsvc/rusers.h>
  268.     h2xs -n ONC::RPC rpcsvc/rusers
  269.  
  270.     # Without constant() or AUTOLOAD
  271.     h2xs -c rpcsvc/rusers
  272.  
  273.     # Creates templates for an extension named RPC
  274.     h2xs -cfn RPC
  275.  
  276.     # Extension is ONC::RPC.
  277.     h2xs -cfn ONC::RPC
  278.  
  279.     # Extension is a pure Perl module with no XS code.
  280.     h2xs -X My::Module
  281.  
  282.     # Extension is Lib::Foo which works at least with Perl5.005_03.
  283.     # Constants are created for all #defines and enums h2xs can find
  284.     # in foo.h.
  285.     h2xs -b 5.5.3 -n Lib::Foo foo.h
  286.  
  287.     # Extension is Lib::Foo which works at least with Perl5.005_03.
  288.     # Constants are created for all #defines but only for enums
  289.     # whose names do not start with 'bar_'.
  290.     h2xs -b 5.5.3 -e '^bar_' -n Lib::Foo foo.h
  291.  
  292.     # Makefile.PL will look for library -lrpc in
  293.     # additional directory /opt/net/lib
  294.     h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
  295.  
  296.     # Extension is DCE::rgynbase
  297.     # prefix "sec_rgy_" is dropped from perl function names
  298.     h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
  299.  
  300.     # Extension is DCE::rgynbase
  301.     # prefix "sec_rgy_" is dropped from perl function names
  302.     # subroutines are created for sec_rgy_wildcard_name and
  303.     # sec_rgy_wildcard_sid
  304.     h2xs -n DCE::rgynbase -p sec_rgy_ \
  305.     -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
  306.  
  307.     # Make XS without defines in perl.h, but with function declarations
  308.     # visible from perl.h. Name of the extension is perl1.
  309.     # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
  310.     # Extra backslashes below because the string is passed to shell.
  311.     # Note that a directory with perl header files would
  312.     #  be added automatically to include path.
  313.     h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
  314.  
  315.     # Same with function declaration in proto.h as visible from perl.h.
  316.     h2xs -xAn perl2 perl.h,proto.h
  317.  
  318.     # Same but select only functions which match /^av_/
  319.     h2xs -M '^av_' -xAn perl2 perl.h,proto.h
  320.  
  321.     # Same but treat SV* etc as "opaque" types
  322.     h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
  323.  
  324. =head2 Extension based on F<.h> and F<.c> files
  325.  
  326. Suppose that you have some C files implementing some functionality,
  327. and the corresponding header files.  How to create an extension which
  328. makes this functionality accessible in Perl?  The example below
  329. assumes that the header files are F<interface_simple.h> and
  330. I<interface_hairy.h>, and you want the perl module be named as
  331. C<Ext::Ension>.  If you need some preprocessor directives and/or
  332. linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
  333. in L<"OPTIONS">.
  334.  
  335. =over
  336.  
  337. =item Find the directory name
  338.  
  339. Start with a dummy run of h2xs:
  340.  
  341.   h2xs -Afn Ext::Ension
  342.  
  343. The only purpose of this step is to create the needed directories, and
  344. let you know the names of these directories.  From the output you can
  345. see that the directory for the extension is F<Ext/Ension>.
  346.  
  347. =item Copy C files
  348.  
  349. Copy your header files and C files to this directory F<Ext/Ension>.
  350.  
  351. =item Create the extension
  352.  
  353. Run h2xs, overwriting older autogenerated files:
  354.  
  355.   h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
  356.  
  357. h2xs looks for header files I<after> changing to the extension
  358. directory, so it will find your header files OK.
  359.  
  360. =item Archive and test
  361.  
  362. As usual, run
  363.  
  364.   cd Ext/Ension
  365.   perl Makefile.PL
  366.   make dist
  367.   make
  368.   make test
  369.  
  370. =item Hints
  371.  
  372. It is important to do C<make dist> as early as possible.  This way you
  373. can easily merge(1) your changes to autogenerated files if you decide
  374. to edit your C<.h> files and rerun h2xs.
  375.  
  376. Do not forget to edit the documentation in the generated F<.pm> file.
  377.  
  378. Consider the autogenerated files as skeletons only, you may invent
  379. better interfaces than what h2xs could guess.
  380.  
  381. Consider this section as a guideline only, some other options of h2xs
  382. may better suit your needs.
  383.  
  384. =back
  385.  
  386. =head1 ENVIRONMENT
  387.  
  388. No environment variables are used.
  389.  
  390. =head1 AUTHOR
  391.  
  392. Larry Wall and others
  393.  
  394. =head1 SEE ALSO
  395.  
  396. L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
  397.  
  398. =head1 DIAGNOSTICS
  399.  
  400. The usual warnings if it cannot read or write the files involved.
  401.  
  402. =head1 LIMITATIONS of B<-x>
  403.  
  404. F<h2xs> would not distinguish whether an argument to a C function
  405. which is of the form, say, C<int *>, is an input, output, or
  406. input/output parameter.  In particular, argument declarations of the
  407. form
  408.  
  409.     int
  410.     foo(n)
  411.     int *n
  412.  
  413. should be better rewritten as
  414.  
  415.     int
  416.     foo(n)
  417.     int &n
  418.  
  419. if C<n> is an input parameter.
  420.  
  421. Additionally, F<h2xs> has no facilities to intuit that a function
  422.  
  423.    int
  424.    foo(addr,l)
  425.     char *addr
  426.     int   l
  427.  
  428. takes a pair of address and length of data at this address, so it is better
  429. to rewrite this function as
  430.  
  431.     int
  432.     foo(sv)
  433.         SV *addr
  434.     PREINIT:
  435.         STRLEN len;
  436.         char *s;
  437.     CODE:
  438.         s = SvPV(sv,len);
  439.         RETVAL = foo(s, len);
  440.     OUTPUT:
  441.         RETVAL
  442.  
  443. or alternately
  444.  
  445.     static int
  446.     my_foo(SV *sv)
  447.     {
  448.     STRLEN len;
  449.     char *s = SvPV(sv,len);
  450.  
  451.     return foo(s, len);
  452.     }
  453.  
  454.     MODULE = foo    PACKAGE = foo    PREFIX = my_
  455.  
  456.     int
  457.     foo(sv)
  458.     SV *sv
  459.  
  460. See L<perlxs> and L<perlxstut> for additional details.
  461.  
  462. =cut
  463.  
  464. # ' # Grr
  465. use strict;
  466.  
  467.  
  468. my( $H2XS_VERSION ) = ' $Revision: 1.23 $ ' =~ /\$Revision:\s+([^\s]+)/;
  469. my $TEMPLATE_VERSION = '0.01';
  470. my @ARGS = @ARGV;
  471. my $compat_version = $];
  472.  
  473. use Getopt::Long;
  474. use Config;
  475. use Text::Wrap;
  476. $Text::Wrap::huge = 'overflow';
  477. $Text::Wrap::columns = 80;
  478. use ExtUtils::Constant qw (WriteConstants WriteMakefileSnippet autoload);
  479. use File::Compare;
  480. use File::Path;
  481.  
  482. sub usage {
  483.     warn "@_\n" if @_;
  484.     die <<EOFUSAGE;
  485. h2xs [OPTIONS ... ] [headerfile [extra_libraries]]
  486. version: $H2XS_VERSION
  487. OPTIONS:
  488.     -A, --omit-autoload   Omit all autoloading facilities (implies -c).
  489.     -B, --beta-version    Use beta \$VERSION of 0.00_01 (ignored if -v).
  490.     -C, --omit-changes    Omit creating the Changes file, add HISTORY heading
  491.                           to stub POD.
  492.     -F, --cpp-flags       Additional flags for C preprocessor/compile.
  493.     -M, --func-mask       Mask to select C functions/macros
  494.                           (default is select all).
  495.     -O, --overwrite-ok    Allow overwriting of a pre-existing extension directory.
  496.     -P, --omit-pod        Omit the stub POD section.
  497.     -X, --omit-XS         Omit the XS portion (implies both -c and -f).
  498.     -a, --gen-accessors   Generate get/set accessors for struct and union members
  499.                           (used with -x).
  500.     -b, --compat-version  Specify a perl version to be backwards compatibile with.
  501.     -c, --omit-constant   Omit the constant() function and specialised AUTOLOAD
  502.                           from the XS file.
  503.     -d, --debugging       Turn on debugging messages.
  504.     -e, --omit-enums      Omit constants from enums in the constant() function.
  505.                           If a pattern is given, only the matching enums are
  506.                           ignored.
  507.     -f, --force           Force creation of the extension even if the C header
  508.                           does not exist.
  509.     -g, --global          Include code for safely storing static data in the .xs file.
  510.     -h, -?, --help        Display this help message.
  511.     -k, --omit-const-func Omit 'const' attribute on function arguments
  512.                           (used with -x).
  513.     -m, --gen-tied-var    Generate tied variables for access to declared
  514.                           variables.
  515.     -n, --name            Specify a name to use for the extension (recommended).
  516.     -o, --opaque-re       Regular expression for \"opaque\" types.
  517.     -p, --remove-prefix   Specify a prefix which should be removed from the
  518.                           Perl function names.
  519.     -s, --const-subs      Create subroutines for specified macros.
  520.     -t, --default-type    Default type for autoloaded constants (default is IV).
  521.         --use-new-tests   Use Test::More in backward compatible modules.
  522.         --use-old-tests   Use the module Test rather than Test::More.
  523.         --skip-exporter   Do not export symbols.
  524.         --skip-ppport     Do not use portability layer.
  525.         --skip-autoloader Do not use the module C<AutoLoader>.
  526.         --skip-strict     Do not use the pragma C<strict>.
  527.         --skip-warnings   Do not use the pragma C<warnings>.
  528.     -v, --version         Specify a version number for this extension.
  529.     -x, --autogen-xsubs   Autogenerate XSUBs using C::Scan.
  530.         --use-xsloader    Use XSLoader in backward compatible modules (ignored
  531.                           when used with -X).
  532.  
  533. extra_libraries
  534.          are any libraries that might be needed for loading the
  535.          extension, e.g. -lm would try to link in the math library.
  536. EOFUSAGE
  537. }
  538.  
  539. my ($opt_A,
  540.     $opt_B,
  541.     $opt_C,
  542.     $opt_F,
  543.     $opt_M,
  544.     $opt_O,
  545.     $opt_P,
  546.     $opt_X,
  547.     $opt_a,
  548.     $opt_c,
  549.     $opt_d,
  550.     $opt_e,
  551.     $opt_f,
  552.     $opt_g,
  553.     $opt_h,
  554.     $opt_k,
  555.     $opt_m,
  556.     $opt_n,
  557.     $opt_o,
  558.     $opt_p,
  559.     $opt_s,
  560.     $opt_v,
  561.     $opt_x,
  562.     $opt_b,
  563.     $opt_t,
  564.     $new_test,
  565.     $old_test,
  566.     $skip_exporter,
  567.     $skip_ppport,
  568.     $skip_autoloader,
  569.     $skip_strict,
  570.     $skip_warnings,
  571.     $use_xsloader
  572.    );
  573.  
  574. Getopt::Long::Configure('bundling');
  575. Getopt::Long::Configure('pass_through');
  576.  
  577. my %options = (
  578.                 'omit-autoload|A'    => \$opt_A,
  579.                 'beta-version|B'     => \$opt_B,
  580.                 'omit-changes|C'     => \$opt_C,
  581.                 'cpp-flags|F=s'      => \$opt_F,
  582.                 'func-mask|M=s'      => \$opt_M,
  583.                 'overwrite_ok|O'     => \$opt_O,
  584.                 'omit-pod|P'         => \$opt_P,
  585.                 'omit-XS|X'          => \$opt_X,
  586.                 'gen-accessors|a'    => \$opt_a,
  587.                 'compat-version|b=s' => \$opt_b,
  588.                 'omit-constant|c'    => \$opt_c,
  589.                 'debugging|d'        => \$opt_d,
  590.                 'omit-enums|e:s'     => \$opt_e,
  591.                 'force|f'            => \$opt_f,
  592.                 'global|g'           => \$opt_g,
  593.                 'help|h|?'           => \$opt_h,
  594.                 'omit-const-func|k'  => \$opt_k,
  595.                 'gen-tied-var|m'     => \$opt_m,
  596.                 'name|n=s'           => \$opt_n,
  597.                 'opaque-re|o=s'      => \$opt_o,
  598.                 'remove-prefix|p=s'  => \$opt_p,
  599.                 'const-subs|s=s'     => \$opt_s,
  600.                 'default-type|t=s'   => \$opt_t,
  601.                 'version|v=s'        => \$opt_v,
  602.                 'autogen-xsubs|x'    => \$opt_x,
  603.                 'use-new-tests'      => \$new_test,
  604.                 'use-old-tests'      => \$old_test,
  605.                 'skip-exporter'      => \$skip_exporter,
  606.                 'skip-ppport'        => \$skip_ppport,
  607.                 'skip-autoloader'    => \$skip_autoloader,
  608.                 'skip-warnings'      => \$skip_warnings,
  609.                 'skip-strict'        => \$skip_strict,
  610.                 'use-xsloader'       => \$use_xsloader,
  611.               );
  612.  
  613. GetOptions(%options) || usage;
  614.  
  615. usage if $opt_h;
  616.  
  617. if( $opt_b ){
  618.     usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
  619.     $opt_b =~ /^v?(\d+)\.(\d+)\.(\d+)/ ||
  620.     usage "You must provide the backwards compatibility version in X.Y.Z form. "
  621.           .  "(i.e. 5.5.0)\n";
  622.     my ($maj,$min,$sub) = ($1,$2,$3);
  623.     if ($maj < 5 || ($maj == 5 && $min < 6)) {
  624.         $compat_version =
  625.         $sub ? sprintf("%d.%03d%02d",$maj,$min,$sub) :
  626.                sprintf("%d.%03d",    $maj,$min);
  627.     } else {
  628.         $compat_version = sprintf("%d.%03d%03d",$maj,$min,$sub);
  629.     }
  630. } else {
  631.     my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d*)/;
  632.     $sub ||= 0;
  633.     warn sprintf <<'EOF', $maj,$min,$sub;
  634. Defaulting to backwards compatibility with perl %d.%d.%d
  635. If you intend this module to be compatible with earlier perl versions, please
  636. specify a minimum perl version with the -b option.
  637.  
  638. EOF
  639. }
  640.  
  641. if( $opt_B ){
  642.     $TEMPLATE_VERSION = '0.00_01';
  643. }
  644.  
  645. if( $opt_v ){
  646.     $TEMPLATE_VERSION = $opt_v;
  647.  
  648.     # check if it is numeric
  649.     my $temp_version = $TEMPLATE_VERSION;
  650.     my $beta_version = $temp_version =~ s/(\d)_(\d\d)/$1$2/;
  651.     my $notnum;
  652.     {
  653.         local $SIG{__WARN__} = sub { $notnum = 1 };
  654.         use warnings 'numeric';
  655.         $temp_version = 0+$temp_version;
  656.     }
  657.  
  658.     if ($notnum) {
  659.         my $module = $opt_n || 'Your::Module';
  660.         warn <<"EOF";
  661. You have specified a non-numeric version.  Unless you supply an
  662. appropriate VERSION class method, users may not be able to specify a
  663. minimum required version with C<use $module versionnum>.
  664.  
  665. EOF
  666.     }
  667.     else {
  668.         $opt_B = $beta_version;
  669.     }
  670. }
  671.  
  672. # -A implies -c.
  673. $skip_autoloader = $opt_c = 1 if $opt_A;
  674.  
  675. # -X implies -c and -f
  676. $opt_c = $opt_f = 1 if $opt_X;
  677.  
  678. $opt_t ||= 'IV';
  679.  
  680. my %const_xsub;
  681. %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
  682.  
  683. my $extralibs = '';
  684.  
  685. my @path_h;
  686.  
  687. while (my $arg = shift) {
  688.     if ($arg =~ /^-l/i) {
  689.         $extralibs .= "$arg ";
  690.         next;
  691.     }
  692.     last if $extralibs;
  693.     push(@path_h, $arg);
  694. }
  695.  
  696. usage "Must supply header file or module name\n"
  697.         unless (@path_h or $opt_n);
  698.  
  699. my $fmask;
  700. my $tmask;
  701.  
  702. $fmask = qr{$opt_M} if defined $opt_M;
  703. $tmask = qr{$opt_o} if defined $opt_o;
  704. my $tmask_all = $tmask && $opt_o eq '.';
  705.  
  706. if ($opt_x) {
  707.   eval {require C::Scan; 1}
  708.     or die <<EOD;
  709. C::Scan required if you use -x option.
  710. To install C::Scan, execute
  711.    perl -MCPAN -e "install C::Scan"
  712. EOD
  713.   unless ($tmask_all) {
  714.     $C::Scan::VERSION >= 0.70
  715.       or die <<EOD;
  716. C::Scan v. 0.70 or later required unless you use -o . option.
  717. You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
  718. To install C::Scan, execute
  719.    perl -MCPAN -e "install C::Scan"
  720. EOD
  721.   }
  722.   if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
  723.     die <<EOD;
  724. C::Scan v. 0.73 or later required to use -m or -a options.
  725. You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
  726. To install C::Scan, execute
  727.    perl -MCPAN -e "install C::Scan"
  728. EOD
  729.   }
  730. }
  731. elsif ($opt_o or $opt_F) {
  732.   warn <<EOD if $opt_o;
  733. Option -o does not make sense without -x.
  734. EOD
  735.   warn <<EOD if $opt_F and $opt_X ;
  736. Option -F does not make sense with -X.
  737. EOD
  738. }
  739.  
  740. my @path_h_ini = @path_h;
  741. my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
  742.  
  743. my $module = $opt_n;
  744.  
  745. if( @path_h ){
  746.     use File::Spec;
  747.     my @paths;
  748.     my $pre_sub_tri_graphs = 1;
  749.     if ($^O eq 'VMS') {  # Consider overrides of default location
  750.       # XXXX This is not equivalent to what the older version did:
  751.       #        it was looking at $hadsys header-file per header-file...
  752.       my($hadsys) = grep s!^sys/!!i , @path_h;
  753.       @paths = qw( Sys$Library VAXC$Include );
  754.       push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
  755.       push @paths, qw( DECC$Library_Include DECC$System_Include );
  756.     }
  757.     else {
  758.       @paths = (File::Spec->curdir(), $Config{usrinc},
  759.         (split ' ', $Config{locincpth}), '/usr/include');
  760.     }
  761.     foreach my $path_h (@path_h) {
  762.         $name ||= $path_h;
  763.     $module ||= do {
  764.       $name =~ s/\.h$//;
  765.       if ( $name !~ /::/ ) {
  766.     $name =~ s#^.*/##;
  767.     $name = "\u$name";
  768.       }
  769.       $name;
  770.     };
  771.  
  772.     if( $path_h =~ s#::#/#g && $opt_n ){
  773.     warn "Nesting of headerfile ignored with -n\n";
  774.     }
  775.     $path_h .= ".h" unless $path_h =~ /\.h$/;
  776.     my $fullpath = $path_h;
  777.     $path_h =~ s/,.*$// if $opt_x;
  778.     $fullpath{$path_h} = $fullpath;
  779.  
  780.     # Minor trickery: we can't chdir() before we processed the headers
  781.     # (so know the name of the extension), but the header may be in the
  782.     # extension directory...
  783.     my $tmp_path_h = $path_h;
  784.     my $rel_path_h = $path_h;
  785.     my @dirs = @paths;
  786.     if (not -f $path_h) {
  787.       my $found;
  788.       for my $dir (@paths) {
  789.     $found++, last
  790.       if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
  791.       }
  792.       if ($found) {
  793.     $rel_path_h = $path_h;
  794.     $fullpath{$path_h} = $fullpath;
  795.       } else {
  796.     (my $epath = $module) =~ s,::,/,g;
  797.     $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
  798.     $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
  799.     $path_h = $tmp_path_h;    # Used during -x
  800.     push @dirs, $epath;
  801.       }
  802.     }
  803.  
  804.     if (!$opt_c) {
  805.       die "Can't find $tmp_path_h in @dirs\n"
  806.     if ( ! $opt_f && ! -f "$rel_path_h" );
  807.       # Scan the header file (we should deal with nested header files)
  808.       # Record the names of simple #define constants into const_names
  809.             # Function prototypes are processed below.
  810.       open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
  811.     defines:
  812.       while (<CH>) {
  813.     if ($pre_sub_tri_graphs) {
  814.         # Preprocess all tri-graphs
  815.         # including things stuck in quoted string constants.
  816.         s/\?\?=/#/g;                         # | ??=|  #|
  817.         s/\?\?\!/|/g;                        # | ??!|  ||
  818.         s/\?\?'/^/g;                         # | ??'|  ^|
  819.         s/\?\?\(/[/g;                        # | ??(|  [|
  820.         s/\?\?\)/]/g;                        # | ??)|  ]|
  821.         s/\?\?\-/~/g;                        # | ??-|  ~|
  822.         s/\?\?\//\\/g;                       # | ??/|  \|
  823.         s/\?\?</{/g;                         # | ??<|  {|
  824.         s/\?\?>/}/g;                         # | ??>|  }|
  825.     }
  826.     if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) {
  827.         my $def = $1;
  828.         my $rest = $2;
  829.         $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
  830.         $rest =~ s/^\s+//;
  831.         $rest =~ s/\s+$//;
  832.         # Cannot do: (-1) and ((LHANDLE)3) are OK:
  833.         #print("Skip non-wordy $def => $rest\n"),
  834.         #  next defines if $rest =~ /[^\w\$]/;
  835.         if ($rest =~ /"/) {
  836.           print("Skip stringy $def => $rest\n") if $opt_d;
  837.           next defines;
  838.         }
  839.         print "Matched $_ ($def)\n" if $opt_d;
  840.         $seen_define{$def} = $rest;
  841.         $_ = $def;
  842.         next if /^_.*_h_*$/i; # special case, but for what?
  843.         if (defined $opt_p) {
  844.           if (!/^$opt_p(\d)/) {
  845.         ++$prefix{$_} if s/^$opt_p//;
  846.           }
  847.           else {
  848.         warn "can't remove $opt_p prefix from '$_'!\n";
  849.           }
  850.         }
  851.         $prefixless{$def} = $_;
  852.         if (!$fmask or /$fmask/) {
  853.         print "... Passes mask of -M.\n" if $opt_d and $fmask;
  854.         $const_names{$_}++;
  855.         }
  856.       }
  857.       }
  858.       if (defined $opt_e and !$opt_e) {
  859.         close(CH);
  860.       }
  861.       else {
  862.     # Work from miniperl too - on "normal" systems
  863.         my $SEEK_SET = eval 'use Fcntl qw/SEEK_SET/; SEEK_SET' or 0;
  864.         seek CH, 0, $SEEK_SET;
  865.         my $src = do { local $/; <CH> };
  866.         close CH;
  867.         no warnings 'uninitialized';
  868.  
  869.         # Remove C and C++ comments
  870.         $src =~ s#/\*[^*]*\*+([^/*][^*]*\*+)*/|("(\\.|[^"\\])*"|'(\\.|[^'\\])*'|.[^/"'\\]*)#$2#gs;
  871.         $src =~ s#//.*$##gm;
  872.  
  873.     while ($src =~ /\benum\s*([\w_]*)\s*\{\s([^}]+)\}/gsc) {
  874.         my ($enum_name, $enum_body) = ($1, $2);
  875.             # skip enums matching $opt_e
  876.             next if $opt_e && $enum_name =~ /$opt_e/;
  877.             my $val = 0;
  878.             for my $item (split /,/, $enum_body) {
  879.                 next if $item =~ /\A\s*\Z/;
  880.                 my ($key, $declared_val) = $item =~ /(\w+)\s*(?:=\s*(.*))?/;
  881.                 $val = defined($declared_val) && length($declared_val) ? $declared_val : 1 + $val;
  882.                 $seen_define{$key} = $val;
  883.                 $const_names{$key} = { name => $key, macro => 1 };
  884.             }
  885.         } # while (...)
  886.       } # if (!defined $opt_e or $opt_e)
  887.     }
  888.     }
  889. }
  890.  
  891. # Save current directory so that C::Scan can use it
  892. my $cwd = File::Spec->rel2abs( File::Spec->curdir );
  893.  
  894. # As Ilya suggested, use a name that contains - and then it can't clash with
  895. # the names of any packages. A directory 'fallback' will clash with any
  896. # new pragmata down the fallback:: tree, but that seems unlikely.
  897. my $constscfname = 'const-c.inc';
  898. my $constsxsfname = 'const-xs.inc';
  899. my $fallbackdirname = 'fallback';
  900.  
  901. my $ext = chdir 'ext' ? 'ext/' : '';
  902.  
  903. my @modparts  = split(/::/,$module);
  904. my $modpname  = join('-', @modparts);
  905. my $modfname  = pop @modparts;
  906. my $modpmdir  = join '/', 'lib', @modparts;
  907. my $modpmname = join '/', $modpmdir, $modfname.'.pm';
  908.  
  909. if ($opt_O) {
  910.     warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
  911. }
  912. else {
  913.     die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
  914. }
  915. -d "$modpname"   || mkpath([$modpname], 0, 0775);
  916. chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
  917.  
  918. my %types_seen;
  919. my %std_types;
  920. my $fdecls = [];
  921. my $fdecls_parsed = [];
  922. my $typedef_rex;
  923. my %typedefs_pre;
  924. my %known_fnames;
  925. my %structs;
  926.  
  927. my @fnames;
  928. my @fnames_no_prefix;
  929. my %vdecl_hash;
  930. my @vdecls;
  931.  
  932. if( ! $opt_X ){  # use XS, unless it was disabled
  933.   unless ($skip_ppport) {
  934.     require Devel::PPPort;
  935.     warn "Writing $ext$modpname/ppport.h\n";
  936.     Devel::PPPort::WriteFile('ppport.h')
  937.         || die "Can't create $ext$modpname/ppport.h: $!\n";
  938.   }
  939.   open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
  940.   if ($opt_x) {
  941.     warn "Scanning typemaps...\n";
  942.     get_typemap();
  943.     my @td;
  944.     my @good_td;
  945.     my $addflags = $opt_F || '';
  946.  
  947.     foreach my $filename (@path_h) {
  948.       my $c;
  949.       my $filter;
  950.  
  951.       if ($fullpath{$filename} =~ /,/) {
  952.     $filename = $`;
  953.     $filter = $';
  954.       }
  955.       warn "Scanning $filename for functions...\n";
  956.       my @styles = $Config{gccversion} ? qw(C++ C9X GNU) : qw(C++ C9X);
  957.       $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
  958.     'add_cppflags' => $addflags, 'c_styles' => \@styles;
  959.       $c->set('includeDirs' => ["$Config::Config{archlib}/CORE", $cwd]);
  960.  
  961.       $c->get('keywords')->{'__restrict'} = 1;
  962.  
  963.       push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
  964.       push(@$fdecls, @{$c->get('fdecls')});
  965.  
  966.       push @td, @{$c->get('typedefs_maybe')};
  967.       if ($opt_a) {
  968.     my $structs = $c->get('typedef_structs');
  969.     @structs{keys %$structs} = values %$structs;
  970.       }
  971.  
  972.       if ($opt_m) {
  973.     %vdecl_hash = %{ $c->get('vdecl_hash') };
  974.     @vdecls = sort keys %vdecl_hash;
  975.     for (local $_ = 0; $_ < @vdecls; ++$_) {
  976.       my $var = $vdecls[$_];
  977.       my($type, $post) = @{ $vdecl_hash{$var} };
  978.       if (defined $post) {
  979.         warn "Can't handle variable '$type $var $post', skipping.\n";
  980.         splice @vdecls, $_, 1;
  981.         redo;
  982.       }
  983.       $type = normalize_type($type);
  984.       $vdecl_hash{$var} = $type;
  985.     }
  986.       }
  987.  
  988.       unless ($tmask_all) {
  989.     warn "Scanning $filename for typedefs...\n";
  990.     my $td = $c->get('typedef_hash');
  991.     # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
  992.     my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
  993.     push @good_td, @f_good_td;
  994.     @typedefs_pre{@f_good_td}  = map $_->[0], @$td{@f_good_td};
  995.       }
  996.     }
  997.     { local $" = '|';
  998.       $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
  999.     }
  1000.     %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
  1001.     if ($fmask) {
  1002.       my @good;
  1003.       for my $i (0..$#$fdecls_parsed) {
  1004.     next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
  1005.     push @good, $i;
  1006.     print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
  1007.       if $opt_d;
  1008.       }
  1009.       $fdecls = [@$fdecls[@good]];
  1010.       $fdecls_parsed = [@$fdecls_parsed[@good]];
  1011.     }
  1012.     @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
  1013.     # Sort declarations:
  1014.     {
  1015.       my %h = map( ($_->[1], $_), @$fdecls_parsed);
  1016.       $fdecls_parsed = [ @h{@fnames} ];
  1017.     }
  1018.     @fnames_no_prefix = @fnames;
  1019.     @fnames_no_prefix
  1020.       = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix
  1021.          if defined $opt_p;
  1022.     # Remove macros which expand to typedefs
  1023.     print "Typedefs are @td.\n" if $opt_d;
  1024.     my %td = map {($_, $_)} @td;
  1025.     # Add some other possible but meaningless values for macros
  1026.     for my $k (qw(char double float int long short unsigned signed void)) {
  1027.       $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
  1028.     }
  1029.     # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
  1030.     my $n = 0;
  1031.     my %bad_macs;
  1032.     while (keys %td > $n) {
  1033.       $n = keys %td;
  1034.       my ($k, $v);
  1035.       while (($k, $v) = each %seen_define) {
  1036.     # print("found '$k'=>'$v'\n"),
  1037.     $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
  1038.       }
  1039.     }
  1040.     # Now %bad_macs contains names of bad macros
  1041.     for my $k (keys %bad_macs) {
  1042.       delete $const_names{$prefixless{$k}};
  1043.       print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
  1044.     }
  1045.   }
  1046. }
  1047. my (@const_specs, @const_names);
  1048.  
  1049. for (sort(keys(%const_names))) {
  1050.     my $v = $const_names{$_};
  1051.     
  1052.     push(@const_specs, ref($v) ? $v : $_);
  1053.     push(@const_names, $_);
  1054. }
  1055.  
  1056. -d $modpmdir || mkpath([$modpmdir], 0, 0775);
  1057. open(PM, ">$modpmname") || die "Can't create $ext$modpname/$modpmname: $!\n";
  1058.  
  1059. $" = "\n\t";
  1060. warn "Writing $ext$modpname/$modpmname\n";
  1061.  
  1062. print PM <<"END";
  1063. package $module;
  1064.  
  1065. use $compat_version;
  1066. END
  1067.  
  1068. print PM <<"END" unless $skip_strict;
  1069. use strict;
  1070. END
  1071.  
  1072. print PM "use warnings;\n" unless $skip_warnings or $compat_version < 5.006;
  1073.  
  1074. unless( $opt_X || $opt_c || $opt_A ){
  1075.     # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
  1076.     # will want Carp.
  1077.     print PM <<'END';
  1078. use Carp;
  1079. END
  1080. }
  1081.  
  1082. print PM <<'END' unless $skip_exporter;
  1083.  
  1084. require Exporter;
  1085. END
  1086.  
  1087. my $use_Dyna = (not $opt_X and $compat_version < 5.006 and not $use_xsloader);
  1088. print PM <<"END" if $use_Dyna;  # use DynaLoader, unless XS was disabled
  1089. require DynaLoader;
  1090. END
  1091.  
  1092.  
  1093. # Are we using AutoLoader or not?
  1094. unless ($skip_autoloader) { # no autoloader whatsoever.
  1095.     unless ($opt_c) { # we're doing the AUTOLOAD
  1096.         print PM "use AutoLoader;\n";
  1097.     }
  1098.     else {
  1099.         print PM "use AutoLoader qw(AUTOLOAD);\n"
  1100.     }
  1101. }
  1102.  
  1103. if ( $compat_version < 5.006 ) {
  1104.     my $vars = '$VERSION @ISA';
  1105.     $vars .= ' @EXPORT @EXPORT_OK %EXPORT_TAGS' unless $skip_exporter;
  1106.     $vars .= ' $AUTOLOAD' unless $opt_X || $opt_c || $opt_A;
  1107.     $vars .= ' $XS_VERSION' if $opt_B && !$opt_X;
  1108.     print PM "use vars qw($vars);";
  1109. }
  1110.  
  1111. # Determine @ISA.
  1112. my @modISA;
  1113. push @modISA, 'Exporter'    unless $skip_exporter;
  1114. push @modISA, 'DynaLoader'     if $use_Dyna;  # no XS
  1115. my $myISA = "our \@ISA = qw(@modISA);";
  1116. $myISA =~ s/^our // if $compat_version < 5.006;
  1117.  
  1118. print PM "\n$myISA\n\n";
  1119.  
  1120. my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
  1121.  
  1122. my $tmp='';
  1123. $tmp .= <<"END" unless $skip_exporter;
  1124. # Items to export into callers namespace by default. Note: do not export
  1125. # names by default without a very good reason. Use EXPORT_OK instead.
  1126. # Do not simply export all your public functions/methods/constants.
  1127.  
  1128. # This allows declaration    use $module ':all';
  1129. # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
  1130. # will save memory.
  1131. our %EXPORT_TAGS = ( 'all' => [ qw(
  1132.     @exported_names
  1133. ) ] );
  1134.  
  1135. our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
  1136.  
  1137. our \@EXPORT = qw(
  1138.     @const_names
  1139. );
  1140.  
  1141. END
  1142.  
  1143. $tmp .= "our \$VERSION = '$TEMPLATE_VERSION';\n";
  1144. if ($opt_B) {
  1145.     $tmp .= "our \$XS_VERSION = \$VERSION;\n" unless $opt_X;
  1146.     $tmp .= "\$VERSION = eval \$VERSION;  # see L<perlmodstyle>\n";
  1147. }
  1148. $tmp .= "\n";
  1149.  
  1150. $tmp =~ s/^our //mg if $compat_version < 5.006;
  1151. print PM $tmp;
  1152.  
  1153. if (@vdecls) {
  1154.     printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
  1155. }
  1156.  
  1157.  
  1158. print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
  1159.  
  1160. if( ! $opt_X ){ # print bootstrap, unless XS is disabled
  1161.   if ($use_Dyna) {
  1162.     $tmp = <<"END";
  1163. bootstrap $module \$VERSION;
  1164. END
  1165.   } else {
  1166.     $tmp = <<"END";
  1167. require XSLoader;
  1168. XSLoader::load('$module', \$VERSION);
  1169. END
  1170.   }
  1171.   $tmp =~ s:\$VERSION:\$XS_VERSION:g if $opt_B;
  1172.   print PM $tmp;
  1173. }
  1174.  
  1175. # tying the variables can happen only after bootstrap
  1176. if (@vdecls) {
  1177.     printf PM <<END;
  1178. {
  1179. @{[ join "\n", map "    _tievar_$_(\$$_);", @vdecls ]}
  1180. }
  1181.  
  1182. END
  1183. }
  1184.  
  1185. my $after;
  1186. if( $opt_P ){ # if POD is disabled
  1187.     $after = '__END__';
  1188. }
  1189. else {
  1190.     $after = '=cut';
  1191. }
  1192.  
  1193. print PM <<"END";
  1194.  
  1195. # Preloaded methods go here.
  1196. END
  1197.  
  1198. print PM <<"END" unless $opt_A;
  1199.  
  1200. # Autoload methods go after $after, and are processed by the autosplit program.
  1201. END
  1202.  
  1203. print PM <<"END";
  1204.  
  1205. 1;
  1206. __END__
  1207. END
  1208.  
  1209. my ($email,$author,$licence);
  1210.  
  1211. eval {
  1212.        my $username;
  1213.        ($username,$author) = (getpwuid($>))[0,6];
  1214.        if (defined $username && defined $author) {
  1215.        $author =~ s/,.*$//; # in case of sub fields
  1216.        my $domain = $Config{'mydomain'};
  1217.        $domain =~ s/^\.//;
  1218.        $email = "$username\@$domain";
  1219.        }
  1220.      };
  1221.  
  1222. $author =~ s/'/\\'/g if defined $author;
  1223. $author ||= "A. U. Thor";
  1224. $email  ||= 'a.u.thor@a.galaxy.far.far.away';
  1225.  
  1226. $licence = sprintf << "DEFAULT", $^V;
  1227. Copyright (C) ${\(1900 + (localtime) [5])} by $author
  1228.  
  1229. This library is free software; you can redistribute it and/or modify
  1230. it under the same terms as Perl itself, either Perl version %vd or,
  1231. at your option, any later version of Perl 5 you may have available.
  1232. DEFAULT
  1233.  
  1234. my $revhist = '';
  1235. $revhist = <<EOT if $opt_C;
  1236. #
  1237. #=head1 HISTORY
  1238. #
  1239. #=over 8
  1240. #
  1241. #=item $TEMPLATE_VERSION
  1242. #
  1243. #Original version; created by h2xs $H2XS_VERSION with options
  1244. #
  1245. #  @ARGS
  1246. #
  1247. #=back
  1248. #
  1249. EOT
  1250.  
  1251. my $exp_doc = $skip_exporter ? '' : <<EOD;
  1252. #
  1253. #=head2 EXPORT
  1254. #
  1255. #None by default.
  1256. #
  1257. EOD
  1258.  
  1259. if (@const_names and not $opt_P) {
  1260.   $exp_doc .= <<EOD unless $skip_exporter;
  1261. #=head2 Exportable constants
  1262. #
  1263. #  @{[join "\n  ", @const_names]}
  1264. #
  1265. EOD
  1266. }
  1267.  
  1268. if (defined $fdecls and @$fdecls and not $opt_P) {
  1269.   $exp_doc .= <<EOD unless $skip_exporter;
  1270. #=head2 Exportable functions
  1271. #
  1272. EOD
  1273.  
  1274. #  $exp_doc .= <<EOD if $opt_p;
  1275. #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
  1276. #
  1277. #EOD
  1278.   $exp_doc .= <<EOD unless $skip_exporter;
  1279. #  @{[join "\n  ", @known_fnames{@fnames}]}
  1280. #
  1281. EOD
  1282. }
  1283.  
  1284. my $meth_doc = '';
  1285.  
  1286. if ($opt_x && $opt_a) {
  1287.   my($name, $struct);
  1288.   $meth_doc .= accessor_docs($name, $struct)
  1289.     while ($name, $struct) = each %structs;
  1290. }
  1291.  
  1292. # Prefix the default licence with hash symbols.
  1293. # Is this just cargo cult - it seems that the first thing that happens to this
  1294. # block is that all the hashes are then s///g out.
  1295. my $licence_hash = $licence;
  1296. $licence_hash =~ s/^/#/gm;
  1297.  
  1298. my $pod;
  1299. $pod = <<"END" unless $opt_P;
  1300. ## Below is stub documentation for your module. You'd better edit it!
  1301. #
  1302. #=head1 NAME
  1303. #
  1304. #$module - Perl extension for blah blah blah
  1305. #
  1306. #=head1 SYNOPSIS
  1307. #
  1308. #  use $module;
  1309. #  blah blah blah
  1310. #
  1311. #=head1 DESCRIPTION
  1312. #
  1313. #Stub documentation for $module, created by h2xs. It looks like the
  1314. #author of the extension was negligent enough to leave the stub
  1315. #unedited.
  1316. #
  1317. #Blah blah blah.
  1318. $exp_doc$meth_doc$revhist
  1319. #
  1320. #=head1 SEE ALSO
  1321. #
  1322. #Mention other useful documentation such as the documentation of
  1323. #related modules or operating system documentation (such as man pages
  1324. #in UNIX), or any relevant external documentation such as RFCs or
  1325. #standards.
  1326. #
  1327. #If you have a mailing list set up for your module, mention it here.
  1328. #
  1329. #If you have a web site set up for your module, mention it here.
  1330. #
  1331. #=head1 AUTHOR
  1332. #
  1333. #$author, E<lt>${email}E<gt>
  1334. #
  1335. #=head1 COPYRIGHT AND LICENSE
  1336. #
  1337. $licence_hash
  1338. #
  1339. #=cut
  1340. END
  1341.  
  1342. $pod =~ s/^\#//gm unless $opt_P;
  1343. print PM $pod unless $opt_P;
  1344.  
  1345. close PM;
  1346.  
  1347.  
  1348. if( ! $opt_X ){ # print XS, unless it is disabled
  1349. warn "Writing $ext$modpname/$modfname.xs\n";
  1350.  
  1351. print XS <<"END";
  1352. #include "EXTERN.h"
  1353. #include "perl.h"
  1354. #include "XSUB.h"
  1355.  
  1356. END
  1357.  
  1358. print XS <<"END" unless $skip_ppport;
  1359. #include "ppport.h"
  1360.  
  1361. END
  1362.  
  1363. if( @path_h ){
  1364.     foreach my $path_h (@path_h_ini) {
  1365.     my($h) = $path_h;
  1366.     $h =~ s#^/usr/include/##;
  1367.     if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
  1368.         print XS qq{#include <$h>\n};
  1369.     }
  1370.     print XS "\n";
  1371. }
  1372.  
  1373. print XS <<"END" if $opt_g;
  1374.  
  1375. /* Global Data */
  1376.  
  1377. #define MY_CXT_KEY "${module}::_guts" XS_VERSION
  1378.  
  1379. typedef struct {
  1380.     /* Put Global Data in here */
  1381.     int dummy;        /* you can access this elsewhere as MY_CXT.dummy */
  1382. } my_cxt_t;
  1383.  
  1384. START_MY_CXT
  1385.  
  1386. END
  1387.  
  1388. my %pointer_typedefs;
  1389. my %struct_typedefs;
  1390.  
  1391. sub td_is_pointer {
  1392.   my $type = shift;
  1393.   my $out = $pointer_typedefs{$type};
  1394.   return $out if defined $out;
  1395.   my $otype = $type;
  1396.   $out = ($type =~ /\*$/);
  1397.   # This converts only the guys which do not have trailing part in the typedef
  1398.   if (not $out
  1399.       and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1400.     $type = normalize_type($type);
  1401.     print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
  1402.       if $opt_d;
  1403.     $out = td_is_pointer($type);
  1404.   }
  1405.   return ($pointer_typedefs{$otype} = $out);
  1406. }
  1407.  
  1408. sub td_is_struct {
  1409.   my $type = shift;
  1410.   my $out = $struct_typedefs{$type};
  1411.   return $out if defined $out;
  1412.   my $otype = $type;
  1413.   $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
  1414.   # This converts only the guys which do not have trailing part in the typedef
  1415.   if (not $out
  1416.       and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1417.     $type = normalize_type($type);
  1418.     print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
  1419.       if $opt_d;
  1420.     $out = td_is_struct($type);
  1421.   }
  1422.   return ($struct_typedefs{$otype} = $out);
  1423. }
  1424.  
  1425. print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
  1426.  
  1427. if( ! $opt_c ) {
  1428.   # We write the "sample" files used when this module is built by perl without
  1429.   # ExtUtils::Constant.
  1430.   # h2xs will later check that these are the same as those generated by the
  1431.   # code embedded into Makefile.PL
  1432.   unless (-d $fallbackdirname) {
  1433.     mkdir "$fallbackdirname" or die "Cannot mkdir $fallbackdirname: $!\n";
  1434.   }
  1435.   warn "Writing $ext$modpname/$fallbackdirname/$constscfname\n";
  1436.   warn "Writing $ext$modpname/$fallbackdirname/$constsxsfname\n";
  1437.   my $cfallback = File::Spec->catfile($fallbackdirname, $constscfname);
  1438.   my $xsfallback = File::Spec->catfile($fallbackdirname, $constsxsfname);
  1439.   WriteConstants ( C_FILE =>       $cfallback,
  1440.                    XS_FILE =>      $xsfallback,
  1441.                    DEFAULT_TYPE => $opt_t,
  1442.                    NAME =>         $module,
  1443.                    NAMES =>        \@const_specs,
  1444.                  );
  1445.   print XS "#include \"$constscfname\"\n";
  1446. }
  1447.  
  1448.  
  1449. my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
  1450.  
  1451. # Now switch from C to XS by issuing the first MODULE declaration:
  1452. print XS <<"END";
  1453.  
  1454. MODULE = $module        PACKAGE = $module        $prefix
  1455.  
  1456. END
  1457.  
  1458. # If a constant() function was #included then output a corresponding
  1459. # XS declaration:
  1460. print XS "INCLUDE: $constsxsfname\n" unless $opt_c;
  1461.  
  1462. print XS <<"END" if $opt_g;
  1463.  
  1464. BOOT:
  1465. {
  1466.     MY_CXT_INIT;
  1467.     /* If any of the fields in the my_cxt_t struct need
  1468.        to be initialised, do it here.
  1469.      */
  1470. }
  1471.  
  1472. END
  1473.  
  1474. foreach (sort keys %const_xsub) {
  1475.     print XS <<"END";
  1476. char *
  1477. $_()
  1478.  
  1479.     CODE:
  1480. #ifdef $_
  1481.     RETVAL = $_;
  1482. #else
  1483.     croak("Your vendor has not defined the $module macro $_");
  1484. #endif
  1485.  
  1486.     OUTPUT:
  1487.     RETVAL
  1488.  
  1489. END
  1490. }
  1491.  
  1492. my %seen_decl;
  1493. my %typemap;
  1494.  
  1495. sub print_decl {
  1496.   my $fh = shift;
  1497.   my $decl = shift;
  1498.   my ($type, $name, $args) = @$decl;
  1499.   return if $seen_decl{$name}++; # Need to do the same for docs as well?
  1500.  
  1501.   my @argnames = map {$_->[1]} @$args;
  1502.   my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
  1503.   if ($opt_k) {
  1504.     s/^\s*const\b\s*// for @argtypes;
  1505.   }
  1506.   my @argarrays = map { $_->[4] || '' } @$args;
  1507.   my $numargs = @$args;
  1508.   if ($numargs and $argtypes[-1] eq '...') {
  1509.     $numargs--;
  1510.     $argnames[-1] = '...';
  1511.   }
  1512.   local $" = ', ';
  1513.   $type = normalize_type($type, 1);
  1514.  
  1515.   print $fh <<"EOP";
  1516.  
  1517. $type
  1518. $name(@argnames)
  1519. EOP
  1520.  
  1521.   for my $arg (0 .. $numargs - 1) {
  1522.     print $fh <<"EOP";
  1523.     $argtypes[$arg]    $argnames[$arg]$argarrays[$arg]
  1524. EOP
  1525.   }
  1526. }
  1527.  
  1528. sub print_tievar_subs {
  1529.   my($fh, $name, $type) = @_;
  1530.   print $fh <<END;
  1531. I32
  1532. _get_$name(IV index, SV *sv) {
  1533.     dSP;
  1534.     PUSHMARK(SP);
  1535.     XPUSHs(sv);
  1536.     PUTBACK;
  1537.     (void)call_pv("$module\::_get_$name", G_DISCARD);
  1538.     return (I32)0;
  1539. }
  1540.  
  1541. I32
  1542. _set_$name(IV index, SV *sv) {
  1543.     dSP;
  1544.     PUSHMARK(SP);
  1545.     XPUSHs(sv);
  1546.     PUTBACK;
  1547.     (void)call_pv("$module\::_set_$name", G_DISCARD);
  1548.     return (I32)0;
  1549. }
  1550.  
  1551. END
  1552. }
  1553.  
  1554. sub print_tievar_xsubs {
  1555.   my($fh, $name, $type) = @_;
  1556.   print $fh <<END;
  1557. void
  1558. _tievar_$name(sv)
  1559.     SV* sv
  1560.     PREINIT:
  1561.     struct ufuncs uf;
  1562.     CODE:
  1563.     uf.uf_val = &_get_$name;
  1564.     uf.uf_set = &_set_$name;
  1565.     uf.uf_index = (IV)&_get_$name;
  1566.     sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
  1567.  
  1568. void
  1569. _get_$name(THIS)
  1570.     $type THIS = NO_INIT
  1571.     CODE:
  1572.     THIS = $name;
  1573.     OUTPUT:
  1574.     SETMAGIC: DISABLE
  1575.     THIS
  1576.  
  1577. void
  1578. _set_$name(THIS)
  1579.     $type THIS
  1580.     CODE:
  1581.     $name = THIS;
  1582.  
  1583. END
  1584. }
  1585.  
  1586. sub print_accessors {
  1587.   my($fh, $name, $struct) = @_;
  1588.   return unless defined $struct && $name !~ /\s|_ANON/;
  1589.   $name = normalize_type($name);
  1590.   my $ptrname = normalize_type("$name *");
  1591.   print $fh <<"EOF";
  1592.  
  1593. MODULE = $module        PACKAGE = ${name}        $prefix
  1594.  
  1595. $name *
  1596. _to_ptr(THIS)
  1597.     $name THIS = NO_INIT
  1598.     PROTOTYPE: \$
  1599.     CODE:
  1600.     if (sv_derived_from(ST(0), "$name")) {
  1601.         STRLEN len;
  1602.         char *s = SvPV((SV*)SvRV(ST(0)), len);
  1603.         if (len != sizeof(THIS))
  1604.         croak("Size \%d of packed data != expected \%d",
  1605.             len, sizeof(THIS));
  1606.         RETVAL = ($name *)s;
  1607.     }
  1608.     else
  1609.         croak("THIS is not of type $name");
  1610.     OUTPUT:
  1611.     RETVAL
  1612.  
  1613. $name
  1614. new(CLASS)
  1615.     char *CLASS = NO_INIT
  1616.     PROTOTYPE: \$
  1617.     CODE:
  1618.     Zero((void*)&RETVAL, sizeof(RETVAL), char);
  1619.     OUTPUT:
  1620.     RETVAL
  1621.  
  1622. MODULE = $module        PACKAGE = ${name}Ptr        $prefix
  1623.  
  1624. EOF
  1625.   my @items = @$struct;
  1626.   while (@items) {
  1627.     my $item = shift @items;
  1628.     if ($item->[0] =~ /_ANON/) {
  1629.       if (defined $item->[2]) {
  1630.     push @items, map [
  1631.       @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
  1632.     ], @{ $structs{$item->[0]} };
  1633.       } else {
  1634.     push @items, @{ $structs{$item->[0]} };
  1635.       }
  1636.     } else {
  1637.       my $type = normalize_type($item->[0]);
  1638.       my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
  1639.       print $fh <<"EOF";
  1640. $ttype
  1641. $item->[2](THIS, __value = NO_INIT)
  1642.     $ptrname THIS
  1643.     $type __value
  1644.     PROTOTYPE: \$;\$
  1645.     CODE:
  1646.     if (items > 1)
  1647.         THIS->$item->[-1] = __value;
  1648.     RETVAL = @{[
  1649.         $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
  1650.     ]};
  1651.     OUTPUT:
  1652.     RETVAL
  1653.  
  1654. EOF
  1655.     }
  1656.   }
  1657. }
  1658.  
  1659. sub accessor_docs {
  1660.   my($name, $struct) = @_;
  1661.   return unless defined $struct && $name !~ /\s|_ANON/;
  1662.   $name = normalize_type($name);
  1663.   my $ptrname = $name . 'Ptr';
  1664.   my @items = @$struct;
  1665.   my @list;
  1666.   while (@items) {
  1667.     my $item = shift @items;
  1668.     if ($item->[0] =~ /_ANON/) {
  1669.       if (defined $item->[2]) {
  1670.     push @items, map [
  1671.       @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
  1672.     ], @{ $structs{$item->[0]} };
  1673.       } else {
  1674.     push @items, @{ $structs{$item->[0]} };
  1675.       }
  1676.     } else {
  1677.       push @list, $item->[2];
  1678.     }
  1679.   }
  1680.   my $methods = (join '(...)>, C<', @list) . '(...)';
  1681.  
  1682.   my $pod = <<"EOF";
  1683. #
  1684. #=head2 Object and class methods for C<$name>/C<$ptrname>
  1685. #
  1686. #The principal Perl representation of a C object of type C<$name> is an
  1687. #object of class C<$ptrname> which is a reference to an integer
  1688. #representation of a C pointer.  To create such an object, one may use
  1689. #a combination
  1690. #
  1691. #  my \$buffer = $name->new();
  1692. #  my \$obj = \$buffer->_to_ptr();
  1693. #
  1694. #This exersizes the following two methods, and an additional class
  1695. #C<$name>, the internal representation of which is a reference to a
  1696. #packed string with the C structure.  Keep in mind that \$buffer should
  1697. #better survive longer than \$obj.
  1698. #
  1699. #=over
  1700. #
  1701. #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
  1702. #
  1703. #Converts an object of type C<$name> to an object of type C<$ptrname>.
  1704. #
  1705. #=item C<$name-E<gt>new()>
  1706. #
  1707. #Creates an empty object of type C<$name>.  The corresponding packed
  1708. #string is zeroed out.
  1709. #
  1710. #=item C<$methods>
  1711. #
  1712. #return the current value of the corresponding element if called
  1713. #without additional arguments.  Set the element to the supplied value
  1714. #(and return the new value) if called with an additional argument.
  1715. #
  1716. #Applicable to objects of type C<$ptrname>.
  1717. #
  1718. #=back
  1719. #
  1720. EOF
  1721.   $pod =~ s/^\#//gm;
  1722.   return $pod;
  1723. }
  1724.  
  1725. # Should be called before any actual call to normalize_type().
  1726. sub get_typemap {
  1727.   # We do not want to read ./typemap by obvios reasons.
  1728.   my @tm =  qw(../../../typemap ../../typemap ../typemap);
  1729.   my $stdtypemap =  "$Config::Config{privlib}/ExtUtils/typemap";
  1730.   unshift @tm, $stdtypemap;
  1731.   my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
  1732.  
  1733.   # Start with useful default values
  1734.   $typemap{float} = 'T_NV';
  1735.  
  1736.   foreach my $typemap (@tm) {
  1737.     next unless -e $typemap ;
  1738.     # skip directories, binary files etc.
  1739.     warn " Scanning $typemap\n";
  1740.     warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
  1741.       unless -T $typemap ;
  1742.     open(TYPEMAP, $typemap)
  1743.       or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
  1744.     my $mode = 'Typemap';
  1745.     while (<TYPEMAP>) {
  1746.       next if /^\s*\#/;
  1747.       if (/^INPUT\s*$/)   { $mode = 'Input'; next; }
  1748.       elsif (/^OUTPUT\s*$/)  { $mode = 'Output'; next; }
  1749.       elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
  1750.       elsif ($mode eq 'Typemap') {
  1751.     next if /^\s*($|\#)/ ;
  1752.     my ($type, $image);
  1753.     if ( ($type, $image) =
  1754.          /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
  1755.          # This may reference undefined functions:
  1756.          and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
  1757.       $typemap{normalize_type($type)} = $image;
  1758.     }
  1759.       }
  1760.     }
  1761.     close(TYPEMAP) or die "Cannot close $typemap: $!";
  1762.   }
  1763.   %std_types = %types_seen;
  1764.   %types_seen = ();
  1765. }
  1766.  
  1767.  
  1768. sub normalize_type {        # Second arg: do not strip const's before \*
  1769.   my $type = shift;
  1770.   my $do_keep_deep_const = shift;
  1771.   # If $do_keep_deep_const this is heuristical only
  1772.   my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
  1773.   my $ignore_mods
  1774.     = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
  1775.   if ($do_keep_deep_const) {    # Keep different compiled /RExen/o separately!
  1776.     $type =~ s/$ignore_mods//go;
  1777.   }
  1778.   else {
  1779.     $type =~ s/$ignore_mods//go;
  1780.   }
  1781.   $type =~ s/([^\s\w])/ $1 /g;
  1782.   $type =~ s/\s+$//;
  1783.   $type =~ s/^\s+//;
  1784.   $type =~ s/\s+/ /g;
  1785.   $type =~ s/\* (?=\*)/*/g;
  1786.   $type =~ s/\. \. \./.../g;
  1787.   $type =~ s/ ,/,/g;
  1788.   $types_seen{$type}++
  1789.     unless $type eq '...' or $type eq 'void' or $std_types{$type};
  1790.   $type;
  1791. }
  1792.  
  1793. my $need_opaque;
  1794.  
  1795. sub assign_typemap_entry {
  1796.   my $type = shift;
  1797.   my $otype = $type;
  1798.   my $entry;
  1799.   if ($tmask and $type =~ /$tmask/) {
  1800.     print "Type $type matches -o mask\n" if $opt_d;
  1801.     $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
  1802.   }
  1803.   elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1804.     $type = normalize_type $type;
  1805.     print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
  1806.     $entry = assign_typemap_entry($type);
  1807.   }
  1808.   # XXX good do better if our UV happens to be long long
  1809.   return "T_NV" if $type =~ /^(unsigned\s+)?long\s+(long|double)\z/;
  1810.   $entry ||= $typemap{$otype}
  1811.     || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
  1812.   $typemap{$otype} = $entry;
  1813.   $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
  1814.   return $entry;
  1815. }
  1816.  
  1817. for (@vdecls) {
  1818.   print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
  1819. }
  1820.  
  1821. if ($opt_x) {
  1822.   for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
  1823.   if ($opt_a) {
  1824.     while (my($name, $struct) = each %structs) {
  1825.       print_accessors(\*XS, $name, $struct);
  1826.     }
  1827.   }
  1828. }
  1829.  
  1830. close XS;
  1831.  
  1832. if (%types_seen) {
  1833.   my $type;
  1834.   warn "Writing $ext$modpname/typemap\n";
  1835.   open TM, ">typemap" or die "Cannot open typemap file for write: $!";
  1836.  
  1837.   for $type (sort keys %types_seen) {
  1838.     my $entry = assign_typemap_entry $type;
  1839.     print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
  1840.   }
  1841.  
  1842.   print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
  1843. #############################################################################
  1844. INPUT
  1845. T_OPAQUE_STRUCT
  1846.     if (sv_derived_from($arg, \"${ntype}\")) {
  1847.         STRLEN len;
  1848.         char  *s = SvPV((SV*)SvRV($arg), len);
  1849.  
  1850.         if (len != sizeof($var))
  1851.         croak(\"Size %d of packed data != expected %d\",
  1852.             len, sizeof($var));
  1853.         $var = *($type *)s;
  1854.     }
  1855.     else
  1856.         croak(\"$var is not of type ${ntype}\")
  1857. #############################################################################
  1858. OUTPUT
  1859. T_OPAQUE_STRUCT
  1860.     sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
  1861. EOP
  1862.  
  1863.   close TM or die "Cannot close typemap file for write: $!";
  1864. }
  1865.  
  1866. } # if( ! $opt_X )
  1867.  
  1868. warn "Writing $ext$modpname/Makefile.PL\n";
  1869. open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
  1870.  
  1871. my $prereq_pm = '';
  1872.  
  1873. if ( $compat_version < 5.00702 and $new_test )
  1874. {
  1875.   $prereq_pm .= q%'Test::More'  =>  0, %;
  1876. }
  1877.  
  1878. if ( $compat_version < 5.00600 and !$opt_X and $use_xsloader)
  1879. {
  1880.   $prereq_pm .= q%'XSLoader'  =>  0, %;
  1881. }
  1882.  
  1883. print PL <<"END";
  1884. use $compat_version;
  1885. use ExtUtils::MakeMaker;
  1886. # See lib/ExtUtils/MakeMaker.pm for details of how to influence
  1887. # the contents of the Makefile that is written.
  1888. WriteMakefile(
  1889.     NAME              => '$module',
  1890.     VERSION_FROM      => '$modpmname', # finds \$VERSION
  1891.     PREREQ_PM         => {$prereq_pm}, # e.g., Module::Name => 1.1
  1892.     (\$] >= 5.005 ?     ## Add these new keywords supported since 5.005
  1893.       (ABSTRACT_FROM  => '$modpmname', # retrieve abstract from module
  1894.        AUTHOR         => '$author <$email>') : ()),
  1895. END
  1896. if (!$opt_X) { # print C stuff, unless XS is disabled
  1897.   $opt_F = '' unless defined $opt_F;
  1898.   my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
  1899.   my $Ihelp = ($I ? '-I. ' : '');
  1900.   my $Icomment = ($I ? '' : <<EOC);
  1901.     # Insert -I. if you add *.h files later:
  1902. EOC
  1903.  
  1904.   print PL <<END;
  1905.     LIBS              => ['$extralibs'], # e.g., '-lm'
  1906.     DEFINE            => '$opt_F', # e.g., '-DHAVE_SOMETHING'
  1907. $Icomment    INC               => '$I', # e.g., '${Ihelp}-I/usr/include/other'
  1908. END
  1909.  
  1910.   my $C = grep {$_ ne "$modfname.c"}
  1911.     (glob '*.c'), (glob '*.cc'), (glob '*.C');
  1912.   my $Cpre = ($C ? '' : '# ');
  1913.   my $Ccomment = ($C ? '' : <<EOC);
  1914.     # Un-comment this if you add C files to link with later:
  1915. EOC
  1916.  
  1917.   print PL <<END;
  1918. $Ccomment    ${Cpre}OBJECT            => '\$(O_FILES)', # link all the C files too
  1919. END
  1920. } # ' # Grr
  1921. print PL ");\n";
  1922. if (!$opt_c) {
  1923.   my $generate_code =
  1924.     WriteMakefileSnippet ( C_FILE =>       $constscfname,
  1925.                            XS_FILE =>      $constsxsfname,
  1926.                            DEFAULT_TYPE => $opt_t,
  1927.                            NAME =>         $module,
  1928.                            NAMES =>        \@const_specs,
  1929.                  );
  1930.   print PL <<"END";
  1931. if  (eval {require ExtUtils::Constant; 1}) {
  1932.   # If you edit these definitions to change the constants used by this module,
  1933.   # you will need to use the generated $constscfname and $constsxsfname
  1934.   # files to replace their "fallback" counterparts before distributing your
  1935.   # changes.
  1936. $generate_code
  1937. }
  1938. else {
  1939.   use File::Copy;
  1940.   use File::Spec;
  1941.   foreach my \$file ('$constscfname', '$constsxsfname') {
  1942.     my \$fallback = File::Spec->catfile('$fallbackdirname', \$file);
  1943.     copy (\$fallback, \$file) or die "Can't copy \$fallback to \$file: \$!";
  1944.   }
  1945. }
  1946. END
  1947.  
  1948.   eval $generate_code;
  1949.   if ($@) {
  1950.     warn <<"EOM";
  1951. Attempting to test constant code in $ext$modpname/Makefile.PL:
  1952. $generate_code
  1953. __END__
  1954. gave unexpected error $@
  1955. Please report the circumstances of this bug in h2xs version $H2XS_VERSION
  1956. using the perlbug script.
  1957. EOM
  1958.   } else {
  1959.     my $fail;
  1960.  
  1961.     foreach my $file ($constscfname, $constsxsfname) {
  1962.       my $fallback = File::Spec->catfile($fallbackdirname, $file);
  1963.       if (compare($file, $fallback)) {
  1964.         warn << "EOM";
  1965. Files "$ext$modpname/$fallbackdirname/$file" and "$ext$modpname/$file" differ.
  1966. EOM
  1967.         $fail++;
  1968.       }
  1969.     }
  1970.     if ($fail) {
  1971.       warn fill ('','', <<"EOM") . "\n";
  1972. It appears that the code in $ext$modpname/Makefile.PL does not autogenerate
  1973. the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname
  1974. correctly.
  1975.  
  1976. Please report the circumstances of this bug in h2xs version $H2XS_VERSION
  1977. using the perlbug script.
  1978. EOM
  1979.     } else {
  1980.       unlink $constscfname, $constsxsfname;
  1981.     }
  1982.   }
  1983. }
  1984. close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
  1985.  
  1986. # Create a simple README since this is a CPAN requirement
  1987. # and it doesnt hurt to have one
  1988. warn "Writing $ext$modpname/README\n";
  1989. open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
  1990. my $thisyear = (gmtime)[5] + 1900;
  1991. my $rmhead = "$modpname version $TEMPLATE_VERSION";
  1992. my $rmheadeq = "=" x length($rmhead);
  1993.  
  1994. my $rm_prereq;
  1995.  
  1996. if ( $compat_version < 5.00702 and $new_test )
  1997. {
  1998.    $rm_prereq = 'Test::More';
  1999. }
  2000. else
  2001. {
  2002.    $rm_prereq = 'blah blah blah';
  2003. }
  2004.  
  2005. print RM <<_RMEND_;
  2006. $rmhead
  2007. $rmheadeq
  2008.  
  2009. The README is used to introduce the module and provide instructions on
  2010. how to install the module, any machine dependencies it may have (for
  2011. example C compilers and installed libraries) and any other information
  2012. that should be provided before the module is installed.
  2013.  
  2014. A README file is required for CPAN modules since CPAN extracts the
  2015. README file from a module distribution so that people browsing the
  2016. archive can use it get an idea of the modules uses. It is usually a
  2017. good idea to provide version information here so that people can
  2018. decide whether fixes for the module are worth downloading.
  2019.  
  2020. INSTALLATION
  2021.  
  2022. To install this module type the following:
  2023.  
  2024.    perl Makefile.PL
  2025.    make
  2026.    make test
  2027.    make install
  2028.  
  2029. DEPENDENCIES
  2030.  
  2031. This module requires these other modules and libraries:
  2032.  
  2033.   $rm_prereq
  2034.  
  2035. COPYRIGHT AND LICENCE
  2036.  
  2037. Put the correct copyright and licence information here.
  2038.  
  2039. $licence
  2040.  
  2041. _RMEND_
  2042. close(RM) || die "Can't close $ext$modpname/README: $!\n";
  2043.  
  2044. my $testdir  = "t";
  2045. my $testfile = "$testdir/$modpname.t";
  2046. unless (-d "$testdir") {
  2047.   mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
  2048. }
  2049. warn "Writing $ext$modpname/$testfile\n";
  2050. my $tests = @const_names ? 2 : 1;
  2051.  
  2052. open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
  2053.  
  2054. print EX <<_END_;
  2055. # Before `make install' is performed this script should be runnable with
  2056. # `make test'. After `make install' it should work as `perl $modpname.t'
  2057.  
  2058. #########################
  2059.  
  2060. # change 'tests => $tests' to 'tests => last_test_to_print';
  2061.  
  2062. _END_
  2063.  
  2064. my $test_mod = 'Test::More';
  2065.  
  2066. if ( $old_test or ($compat_version < 5.007 and not $new_test ))
  2067. {
  2068.   my $test_mod = 'Test';
  2069.  
  2070.   print EX <<_END_;
  2071. use Test;
  2072. BEGIN { plan tests => $tests };
  2073. use $module;
  2074. ok(1); # If we made it this far, we're ok.
  2075.  
  2076. _END_
  2077.  
  2078.    if (@const_names) {
  2079.      my $const_names = join " ", @const_names;
  2080.      print EX <<'_END_';
  2081.  
  2082. my $fail;
  2083. foreach my $constname (qw(
  2084. _END_
  2085.  
  2086.      print EX wrap ("\t", "\t", $const_names);
  2087.      print EX (")) {\n");
  2088.  
  2089.      print EX <<_END_;
  2090.   next if (eval "my \\\$a = \$constname; 1");
  2091.   if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
  2092.     print "# pass: \$\@";
  2093.   } else {
  2094.     print "# fail: \$\@";
  2095.     \$fail = 1;
  2096.   }
  2097. }
  2098. if (\$fail) {
  2099.   print "not ok 2\\n";
  2100. } else {
  2101.   print "ok 2\\n";
  2102. }
  2103.  
  2104. _END_
  2105.   }
  2106. }
  2107. else
  2108. {
  2109.   print EX <<_END_;
  2110. use Test::More tests => $tests;
  2111. BEGIN { use_ok('$module') };
  2112.  
  2113. _END_
  2114.  
  2115.    if (@const_names) {
  2116.      my $const_names = join " ", @const_names;
  2117.      print EX <<'_END_';
  2118.  
  2119. my $fail = 0;
  2120. foreach my $constname (qw(
  2121. _END_
  2122.  
  2123.      print EX wrap ("\t", "\t", $const_names);
  2124.      print EX (")) {\n");
  2125.  
  2126.      print EX <<_END_;
  2127.   next if (eval "my \\\$a = \$constname; 1");
  2128.   if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
  2129.     print "# pass: \$\@";
  2130.   } else {
  2131.     print "# fail: \$\@";
  2132.     \$fail = 1;
  2133.   }
  2134.  
  2135. }
  2136.  
  2137. ok( \$fail == 0 , 'Constants' );
  2138. _END_
  2139.   }
  2140. }
  2141.  
  2142. print EX <<_END_;
  2143. #########################
  2144.  
  2145. # Insert your test code below, the $test_mod module is use()ed here so read
  2146. # its man page ( perldoc $test_mod ) for help writing this test script.
  2147.  
  2148. _END_
  2149.  
  2150. close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
  2151.  
  2152. unless ($opt_C) {
  2153.   warn "Writing $ext$modpname/Changes\n";
  2154.   $" = ' ';
  2155.   open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
  2156.   @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
  2157.   print EX <<EOP;
  2158. Revision history for Perl extension $module.
  2159.  
  2160. $TEMPLATE_VERSION  @{[scalar localtime]}
  2161. \t- original version; created by h2xs $H2XS_VERSION with options
  2162. \t\t@ARGS
  2163.  
  2164. EOP
  2165.   close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
  2166. }
  2167.  
  2168. warn "Writing $ext$modpname/MANIFEST\n";
  2169. open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
  2170. my @files = grep { -f } (<*>, <t/*>, <$fallbackdirname/*>, <$modpmdir/*>);
  2171. if (!@files) {
  2172.   eval {opendir(D,'.');};
  2173.   unless ($@) { @files = readdir(D); closedir(D); }
  2174. }
  2175. if (!@files) { @files = map {chomp && $_} `ls`; }
  2176. if ($^O eq 'VMS') {
  2177.   foreach (@files) {
  2178.     # Clip trailing '.' for portability -- non-VMS OSs don't expect it
  2179.     s%\.$%%;
  2180.     # Fix up for case-sensitive file systems
  2181.     s/$modfname/$modfname/i && next;
  2182.     $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
  2183.     $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
  2184.   }
  2185. }
  2186. print MANI join("\n",@files), "\n";
  2187. close MANI;
  2188.